[Hub Generated] Review request for Microsoft.HybridCompute to add version stable/2022-12-27 #23282
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…022-12-27-preview to version 2022-12-27
|
Hi, @dorothyhu Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected] |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| HybridCompute.json | 2022-12-27(682a101) | 2022-11-10(main) |
| HybridCompute.json | 2022-12-27(682a101) | 2022-12-27-preview(main) |
| privateLinkScopes.json | 2022-12-27(682a101) | 2022-11-10(main) |
| privateLinkScopes.json | 2022-12-27(682a101) | 2022-12-27-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 4 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-2022-12 | package-2022-12(682a101) | default(main) |
| default | default(682a101) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| Based on the response model schema, operation 'Machines_Get' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.HybridCompute/stable/2022-12-27/HybridCompute.json#L197 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.HybridCompute/stable/2022-12-27/HybridCompute.json#L2021 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.HybridCompute/stable/2022-12-27/HybridCompute.json#L2226 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.HybridCompute/stable/2022-12-27/HybridCompute.json#L2315 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The resource name parameter 'extensionName' should be defined with a 'pattern' restriction. Location: Microsoft.HybridCompute/stable/2022-12-27/HybridCompute.json#L475 |
|
An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.HybridCompute/stable/2022-12-27/HybridCompute.json#L476 |
|
A 'put' operation 'MachineExtensions_CreateOrUpdate' with x-ms-long-running-operation extension must have a valid terminal success status code 200 or 201. Location: Microsoft.HybridCompute/stable/2022-12-27/HybridCompute.json#L476 |
|
An async PUT operation must return 201. Location: Microsoft.HybridCompute/stable/2022-12-27/HybridCompute.json#L519 |
|
Only 201 is the supported response code for PUT async response. Location: Microsoft.HybridCompute/stable/2022-12-27/HybridCompute.json#L526 |
|
A 202 response should include an Location response header. Location: Microsoft.HybridCompute/stable/2022-12-27/HybridCompute.json#L526 |
|
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.HybridCompute/stable/2022-12-27/HybridCompute.json#L625 |
|
An async POST operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.HybridCompute/stable/2022-12-27/HybridCompute.json#L813 |
|
Top level properties should be one of name, type, id, location, properties, tags, plan, sku, etag, managedBy, identity, zones. Model definition 'Machine' has extra properties ['resources']. Location: Microsoft.HybridCompute/stable/2022-12-27/HybridCompute.json#L1632 |
|
Top level property names should not be repeated inside the properties bag for ARM resource 'MachineExtension'. Properties [properties.type] conflict with ARM top level properties. Please rename these. Location: Microsoft.HybridCompute/stable/2022-12-27/HybridCompute.json#L1711 |
|
The resource name parameter 'scopeName' should be defined with a 'pattern' restriction. Location: Microsoft.HybridCompute/stable/2022-12-27/privateLinkScopes.json#L115 |
|
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.HybridCompute/stable/2022-12-27/privateLinkScopes.json#L116 |
|
A 'delete' operation 'PrivateLinkScopes_Delete' with x-ms-long-running-operation extension must have a valid terminal success status code 200 or 204. Location: Microsoft.HybridCompute/stable/2022-12-27/privateLinkScopes.json#L116 |
|
The resource name parameter 'scopeName' should be defined with a 'pattern' restriction. Location: Microsoft.HybridCompute/stable/2022-12-27/privateLinkScopes.json#L311 |
|
The resource name parameter 'scopeName' should be defined with a 'pattern' restriction. Location: Microsoft.HybridCompute/stable/2022-12-27/privateLinkScopes.json#L356 |
|
The resource name parameter 'groupName' should be defined with a 'pattern' restriction. Location: Microsoft.HybridCompute/stable/2022-12-27/privateLinkScopes.json#L356 |
|
The resource name parameter 'scopeName' should be defined with a 'pattern' restriction. Location: Microsoft.HybridCompute/stable/2022-12-27/privateLinkScopes.json#L401 |
|
The resource name parameter 'privateEndpointConnectionName' should be defined with a 'pattern' restriction. Location: Microsoft.HybridCompute/stable/2022-12-27/privateLinkScopes.json#L401 |
|
An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.HybridCompute/stable/2022-12-27/privateLinkScopes.json#L449 |
|
An async PUT operation must return 201. Location: Microsoft.HybridCompute/stable/2022-12-27/privateLinkScopes.json#L484 |
|
Only 201 is the supported response code for PUT async response. Location: Microsoft.HybridCompute/stable/2022-12-27/privateLinkScopes.json#L491 |
|
A 202 response should include an Location response header. Location: Microsoft.HybridCompute/stable/2022-12-27/privateLinkScopes.json#L491 |
|
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.HybridCompute/stable/2022-12-27/privateLinkScopes.json#L508 |
|
The resource name parameter 'scopeName' should be defined with a 'pattern' restriction. Location: Microsoft.HybridCompute/stable/2022-12-27/privateLinkScopes.json#L575 |
|
The path for nested resource doest not meet the valid resource pattern. Location: Microsoft.HybridCompute/stable/2022-12-27/privateLinkScopes.json#L659 |
|
The resource name parameter 'machineName' should be defined with a 'pattern' restriction. Location: Microsoft.HybridCompute/stable/2022-12-27/privateLinkScopes.json#L659 |
| A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'Machines_CreateOrUpdate' Request Model: 'parameters[4].schema' Response Model: 'responses[200].schema' Location: Microsoft.HybridCompute/stable/2022-12-27/HybridCompute.json#L38 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: List Machines by resource group Location: Microsoft.HybridCompute/stable/2022-12-27/HybridCompute.json#L465 |
|
| A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'MachineExtensions_CreateOrUpdate' Request Model: 'parameters[3].schema' Response Model: 'responses[200].schema' Location: Microsoft.HybridCompute/stable/2022-12-27/HybridCompute.json#L476 |
|
| The x-ms-long-running-operation-options should be specified explicitly to indicate the type of response header to track the async operation. Location: Microsoft.HybridCompute/stable/2022-12-27/HybridCompute.json#L476 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
ghost
added
the
Generated ApiView
|
|
Hi @dorothyhu and @arcboard, one or more change(s) have been detected in your Arc enabled VM's or Arc enabled Server's RPs. Please review the changes and ensure that no gaps have been introduced with respect to the ARM API modeling consistency across Azure Arc and Azure Compute. For further details, see guidelines at Consistency in ARM Modeling. To approve the change(s), set the label to ArcSignedOff. If you have any questions, please mail to [email protected]. |
* Added UMC operations Added UMC operations * Fixed CR comments
AzureRestAPISpecReview
added
ARMReview
BreakingChangeReviewRequired
|
Hi @dorothyhu, Your PR has some issues. Please fix the CI sequentially by following the order of
|
|
Hi @dorothyhu, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review. |
This was referenced Mar 30, 2023
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
zizw123
reviewed
Apr 11, 2023
| "description": "The operation to assess patches on a hybrid machine identity in Azure.", | ||
| "parameters": [ | ||
| { | ||
| "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" |
zizw123
reviewed
Apr 11, 2023
| "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" | ||
| }, | ||
| { | ||
| "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" |
zizw123
reviewed
Apr 11, 2023
| "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" | ||
| }, | ||
| { | ||
| "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" |
zizw123
reviewed
Apr 11, 2023
| "description": "The activity ID of the operation that produced this result." | ||
| }, | ||
| "rebootPending": { | ||
| "type": "boolean", |
|
non-blocking comments |
zizw123
added
the
ARMSignedOff
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
|
@zizw123 I'd prefer to address your comments in an upcoming swagger change. We're trying to make this one just a straight port of the assesspatches calls from the earlier swagger version to this one, without changing anything else. How do we rerun the readiness checks? Those were run several weeks ago and there has been a deployment since which should have addressed them |
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
Please check Avocado CI. |
@weidongxu-microsoft This warning was expected. We removed the reconnect API a long time ago. |
|
OK, I can skip it once for you, but it will just show forever in all future PRs, and likely everyone is going to ask same question... @josefree for awareness. BTW, the "API Readiness Check" still fails. Are you sure you've deployed it and get all regions online? |
|
No, the build has not reached all regions yet. Should complete end of week.
…On Mon, Apr 17, 2023 at 6:51 PM Weidong Xu ***@***.***> wrote:
@dorothyhu <https://github.com/dorothyhu>
OK, I can skip it once for you, but it will just show forever in all
future PRs, and likely everyone is going to ask same question... @josefree
<https://github.com/josefree> for awareness.
BTW, the "API Readiness Check" still fails. Are you sure you've deployed
it and get all regions online?
—
Reply to this email directly, view it on GitHub
<#23282 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AAALECQHEX6C5TAH7FABY6DXBXXRBANCNFSM6AAAAAAWG3NRFY>
.
You are receiving this because you commented.Message ID:
***@***.***>
|
|
OK. I can merge it now, or wait and retry the CI early next week. But don't request SDK release before it get deployed to all regions. |
|
Please fix the conflict. |
weidongxu-microsoft
approved these changes
Apr 25, 2023
AzureRestAPISpecReview
added
ReadyForApiTest
weidongxu-microsoft
deleted the
dorothyhu-hybridcompute-Microsoft.HybridCompute-2022-12-27
branch
This was referenced Apr 25, 2023
JoshLove-msft
pushed a commit
to JoshLove-msft/azure-rest-api-specs
that referenced
this pull request
Apr 25, 2023
…sion stable/2022-12-27 (Azure#23282) * Adds base for updating Microsoft.HybridCompute from version preview/2022-12-27-preview to version 2022-12-27 * Updates readme * Updates API version in new specs and examples * Added UMC operations (Azure#23320) * Added UMC operations Added UMC operations * Fixed CR comments * fixed model validation error --------- Co-authored-by: assing <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a PR generated at OpenAPI Hub. You can view your work branch via this link.
ARM API Information (Control Plane)
Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist (MS Employees Only):
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Otherwise your PR may be subject to ARM review requirements. Complete the following:
Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
-[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.
Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
Breaking Change Review Checklist
If you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.
NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)
Please follow the link to find more details on PR review process.